Use custom gomega matcher for protobuf equality #4966
Conversation
|
@bestbeforetoday Sorry, I see your change is still in the draft. But I'll ask you a question right away. For example: |
bestbeforetoday
force-pushed
the
protoequal
branch
from
6d83802
to
a5caa89
Compare
|
@pfi79 Covering both protobuf and non-protobuf elements in a single matcher is definitely possible. It would essentially mean duplicating the behaviour of the existing gomega Equal matcher and extending it to handle protobuf messages using proto.Equal. That is (much) more work than I was planning to tackle in this PR. Instead I was planning just what is implemented here — a matcher for protobuf messages to avoid the need for contributors to remember and use a pattern such as: Expect(proto.Equal(value1, value2)).To(BeTrue()) |
bestbeforetoday
force-pushed
the
protoequal
branch
from
a5caa89
to
412114c
Compare
The standard gomega Equal matcher is not reliable when used with
protobuf messages since they can be logically equal while containing
different implementation field values. This change implements a custom
ProtoEqual matcher that uses proto.Equal for reliable equality checks.
A failed match produces output similar to the following:
```
[FAILED] Expected
ChaincodeMessage{
type: TRANSACTION
payload: "\n\x04arg1\n\x04arg2"
txid: "tx-id"
proposal: {
proposal_bytes: "signed-proposal-bytes"
signature: "signature"
}
channel_id: "channel-id"
}
to equal
SignedProposal{
proposal_bytes: "signed-proposal-bytes"
signature: "signature"
}
```
Signed-off-by: Mark S. Lewis <Mark.S.Lewis@outlook.com>
bestbeforetoday
force-pushed
the
protoequal
branch
from
412114c
to
baf360f
Compare
bestbeforetoday
changed the title
The standard gomega Equal matcher is not reliable when used with protobuf messages since they can be logically equal while containing different implementation field values. This change implements a custom ProtoEqual matcher that uses proto.Equal for reliable equality checks.
This implementation enables the following:
which is a more idiomatic alternative to:
In addition, a failed match produces output similar to the following, which is significantly more informative than a message simply stating that false is expected to be true: